Class: ContentApi
ContentApi - object-oriented interface
Export
Hierarchy
↳
ContentApi
Table of contents
Constructors
Properties
Methods
- contentAddCarPost
- contentAddIpfsPost
- contentAddPost
- contentAggregatedContentGet
- contentAllDealsGet
- contentBwUsageContentGet
- contentCreatePost
- contentDealsGet
- contentEnsureReplicationDatacidGet
- contentFailuresContentGet
- contentIdGet
- contentImportdealPost
- contentListGet
- contentReadContGet
- contentStagingZonesGet
- contentStatsGet
- contentStatusIdGet
Constructors
constructor
• new ContentApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
contentAddCarPost
▸ contentAddCarPost(body, ignoreDupes?, filename?, options?): Promise<Response>
This endpoint is used to add a car object to the network. The object can be a file or a directory.
Summary
Add Car object
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
body | string | Car |
ignoreDupes? | string | Ignore Dupes |
filename? | string | Filename |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3291
contentAddIpfsPost
▸ contentAddIpfsPost(body, ignoreDupes?, options?): Promise<Response>
This endpoint is used to add an IPFS object to the network. The object can be a file or a directory.
Summary
Add IPFS object
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
body | UtilContentAddIpfsBody | IPFS Body |
ignoreDupes? | string | Ignore Dupes |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3304
contentAddPost
▸ contentAddPost(data, filename?, coluuid?, replication?, ignoreDupes?, lazyProvide?, dir?, options?): Promise<UtilContentAddResponse>
This endpoint is used to upload new content.
Summary
Add new content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
data | any | File to upload |
filename? | string | Filenam to use for upload |
coluuid? | string | Collection UUID |
replication? | number | Replication value |
ignoreDupes? | string | Ignore Dupes true/false |
lazyProvide? | string | Lazy Provide true/false |
dir? | string | Directory |
options? | any | Override http request option. |
Returns
Promise<UtilContentAddResponse>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3322
contentAggregatedContentGet
▸ contentAggregatedContentGet(content, options?): Promise<string>
This endpoint returns aggregated content stats
Summary
Get aggregated content stats
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
content | string | Content ID |
options? | any | Override http request option. |
Returns
Promise<string>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3334
contentAllDealsGet
▸ contentAllDealsGet(begin, duration, all, options?): Promise<Response>
This endpoint is used to get all deals for a user
Summary
Get all deals for a user
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
begin | string | Begin |
duration | string | Duration |
all | string | All |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3348
contentBwUsageContentGet
▸ contentBwUsageContentGet(content, options?): Promise<Response>
This endpoint returns content bandwidth
Summary
Get content bandwidth
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
content | string | Content ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3360
contentCreatePost
▸ contentCreatePost(req, ignoreDupes?, options?): Promise<Response>
This endpoint adds a new content
Summary
Add a new content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
req | UtilContentCreateBody | Content |
ignoreDupes? | string | Ignore Dupes |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3373
contentDealsGet
▸ contentDealsGet(limit?, offset?, options?): Promise<Response>
This endpoint lists all content with deals
Summary
Content with deals
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
limit? | number | Limit |
offset? | number | Offset |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3386
contentEnsureReplicationDatacidGet
▸ contentEnsureReplicationDatacidGet(datacid, options?): Promise<Response>
This endpoint ensures that the content is replicated to the specified number of providers
Summary
Ensure Replication
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
datacid | string | Data CID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3398
contentFailuresContentGet
▸ contentFailuresContentGet(content, options?): Promise<string>
This endpoint returns all failures for a content
Summary
List all failures for a content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
content | string | Content ID |
options? | any | Override http request option. |
Returns
Promise<string>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3410
contentIdGet
▸ contentIdGet(id, options?): Promise<Response>
This endpoint returns a content by its ID
Summary
Content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
id | number | Content ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3422
contentImportdealPost
▸ contentImportdealPost(body, options?): Promise<Response>
This endpoint imports a deal into the shuttle.
Summary
Import a deal
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
body | MainImportDealBody | Import a deal |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3434
contentListGet
▸ contentListGet(options?): Promise<string[]>
This endpoint lists all content
Summary
List all pinned content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3445
contentReadContGet
▸ contentReadContGet(cont, options?): Promise<Response>
This endpoint reads content from the blockstore
Summary
Read content
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
cont | string | CID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3457
contentStagingZonesGet
▸ contentStagingZonesGet(options?): Promise<Response>
This endpoint is used to get staging zone for user.
Summary
Get staging zone for user
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3468
contentStatsGet
▸ contentStatsGet(limit, offset, options?): Promise<Response>
This endpoint is used to get content statistics. Every content stored in the network (estuary) is tracked by a unique ID which can be used to get information about the content. This endpoint will allow the consumer to get the collected stats of a conten
Summary
Get content statistics
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
limit | string | limit |
offset | string | offset |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:3481
contentStatusIdGet
▸ contentStatusIdGet(id, options?): Promise<Response>
This endpoint returns the status of a content
Summary
Content Status
Throws
Memberof
ContentApi
Parameters
| Name | Type | Description |
|---|---|---|
id | number | Content ID |
options? | any | Override http request option. |
Returns
Promise<Response>